Calcular Total de Custos

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Descrição dos campos

Campo	Tipo	Descrição
costs[].description	string	Descrição do custo.
costs[].amount	number	Valor do custo.

Requisição

POST https://api-sandbox.catalisa.com.br/calc-engine/api/loan-costs-calculator/calculations JWT scope: calculations-engine/calculate

Parâmetros

Sem parâmetros

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
    "data": {
        "type": "calculations",
        "attributes": {
            "costs": [
                {
                    "description": "TAC",
                    "amount": 100
                },
                {
                    "description": "Labor",
                    "amount": 200
                },
                {
                    "description": "Materials",
                    "amount": 150
                },
                {
                    "description": "Equipment",
                    "amount": 300
                },
                {
                    "description": "Travel",
                    "amount": 120
                },
                {
                    "description": "Administration",
                    "amount": 250
                },
                {
                    "description": "Marketing",
                    "amount": 180
                },
                {
                    "description": "Rent",
                    "amount": 350
                },
                {
                    "description": "Utilities",
                    "amount": 100
                },
                {
                    "description": "Miscellaneous",
                    "amount": 75
                }
            ]
        }
    }
}

Respostas

Código	Descrição
201	Criado com sucesso. Retorna os dados da tabela de amortização.
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const body = JSON.stringify({
    data: {
        type: "calculations",
        attributes: {
            costs: [
                {
                    description: "TAC",
                    amount: 100
                },
                {
                    description: "Labor",
                    amount: 200
                },
                {
                    description: "Materials",
                    amount: 150
                },
                {
                    description: "Equipment",
                    amount: 300
                },
                {
                    description: "Travel",
                    amount: 120
                },
                {
                    description: "Administration",
                    amount: 250
                },
                {
                    description: "Marketing",
                    amount: 180
                },
                {
                    description: "Rent",
                    amount: 350
                },
                {
                    description: "Utilities",
                    amount: 100
                },
                {
                    description: "Miscellaneous",
                    amount: 75
                }
            ]
        }
    }
});

const requestOptions = {
  method: "POST",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/calc-engine/api/loan-costs-calculator/calculations",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location 'https://api-sandbox.catalisa.com.br/calc-engine/api/loan-costs-calculator/calculations' \
--header 'Authorization: Bearer <token>' \
--data '{
    "data": {
        "type": "calculations",
        "attributes": {
            "costs": [
                {
                    "description": "TAC",
                    "amount": 100
                },
                {
                    "description": "Labor",
                    "amount": 200
                },
                {
                    "description": "Materials",
                    "amount": 150
                },
                {
                    "description": "Equipment",
                    "amount": 300
                },
                {
                    "description": "Travel",
                    "amount": 120
                },
                {
                    "description": "Administration",
                    "amount": 250
                },
                {
                    "description": "Marketing",
                    "amount": 180
                },
                {
                    "description": "Rent",
                    "amount": 350
                },
                {
                    "description": "Utilities",
                    "amount": 100
                },
                {
                    "description": "Miscellaneous",
                    "amount": 75
                }
            ]
        }
    }
}
'

Exemplo de Sucesso

{
  "data": {
    "id": "e297492a-baad-47a4-bbaf-423a47de7737",
    "type": "calculations",
    "attributes": {
      "costs_total": 1825
    }
  }
}